SGI Freeware 1999 August/SGI Freeware 1999 August.iso/dist/fw_qt.idb/usr/freeware/catman/p_man/cat3/qframe.Z/qframe

Text File | 1998-10-28 | 23.1 KB | 463 lines

     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



     NNNNAAAAMMMMEEEE
      QFrame - The base class of widgets that have an (optional)
      frame

     SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
      #include <qframe.h>

      Inherits QWidget.

      Inherited by QGroupBox, QLCDNumber, QLabel, QMenuBar,
      QProgressBar,    QScrollView, QSpinBox, QSplitter, QTableView
      and QWidgetStack.

    PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
      QQQQFFFFrrrraaaammmmeeee (((( QQQQWWWWiiiiddddggggeeeetttt **** _p_a_r_e_n_t====0000,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr **** _n_a_m_e====0000,,,, WWWWFFFFllllaaaaggggssss _f
      eeeennnnuuuummmm {{{{ NNNNooooFFFFrrrraaaammmmeeee ==== 0000,,,, BBBBooooxxxx ==== 0000xxxx0000000000001111,,,, PPPPaaaannnneeeellll ==== 0000xxxx0000000000002222,,,, WWWWiiiinnnnPPPPaaaannnneeeellll ====
          0000xxxx0000000000003333,,,, HHHHLLLLiiiinnnneeee ==== 0000xxxx0000000000004444,,,, VVVVLLLLiiiinnnneeee ==== 0000xxxx0000000000005555,,,, MMMMSSSShhhhaaaappppeeee ==== 0000xxxx000000000000ffff,,,,
          PPPPllllaaaaiiiinnnn ==== 0000xxxx0000000011110000,,,, RRRRaaaaiiiisssseeeedddd ==== 0000xxxx0000000022220000,,,, SSSSuuuunnnnkkkkeeeennnn ====    0000xxxx0000000033330000,,,,
          MMMMSSSShhhhaaaaddddoooowwww ====    0000xxxx00000000ffff0000 }}}}
      iiiinnnntttt ffffrrrraaaammmmeeeeSSSSttttyyyylllleeee (((()))) ccccoooonnnnsssstttt
      iiiinnnntttt ffffrrrraaaammmmeeeeSSSShhhhaaaappppeeee (((()))) ccccoooonnnnsssstttt
      iiiinnnntttt ffffrrrraaaammmmeeeeSSSShhhhaaaaddddoooowwww (((()))) ccccoooonnnnsssstttt
      vvvvooooiiiidddd sssseeeettttFFFFrrrraaaammmmeeeeSSSSttttyyyylllleeee (((( iiiinnnntttt ))))
      bbbboooooooollll lllliiiinnnneeeeSSSShhhhaaaappppeeeessssOOOOkkkk (((()))) ccccoooonnnnsssstttt
      iiiinnnntttt lllliiiinnnneeeeWWWWiiiiddddtttthhhh    (((()))) ccccoooonnnnsssstttt
      vvvvooooiiiidddd sssseeeettttLLLLiiiinnnneeeeWWWWiiiiddddtttthhhh (((( iiiinnnntttt ))))
      iiiinnnntttt mmmmaaaarrrrggggiiiinnnn (((())))    ccccoooonnnnsssstttt
      vvvvooooiiiidddd sssseeeettttMMMMaaaarrrrggggiiiinnnn (((( iiiinnnntttt ))))
      iiiinnnntttt mmmmiiiiddddLLLLiiiinnnneeeeWWWWiiiiddddtttthhhh (((()))) ccccoooonnnnsssstttt
      vvvvooooiiiidddd sssseeeettttMMMMiiiiddddLLLLiiiinnnneeeeWWWWiiiiddddtttthhhh (((( iiiinnnntttt ))))
      iiiinnnntttt ffffrrrraaaammmmeeeeWWWWiiiiddddtttthhhh (((()))) ccccoooonnnnsssstttt
      QQQQRRRReeeecccctttt    ffffrrrraaaammmmeeeeRRRReeeecccctttt (((()))) ccccoooonnnnsssstttt
      QQQQRRRReeeecccctttt    ccccoooonnnntttteeeennnnttttssssRRRReeeecccctttt (((())))    ccccoooonnnnsssstttt
      vvvviiiirrrrttttuuuuaaaallll QQQQSSSSiiiizzzzeeee    ssssiiiizzzzeeeeHHHHiiiinnnntttt (((()))) ccccoooonnnnsssstttt

    PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss
      vvvvooooiiiidddd sssseeeettttFFFFrrrraaaammmmeeeeRRRReeeecccctttt (((( ccccoooonnnnsssstttt QQQQRRRReeeecccctttt &&&& ))))
      vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd ppppaaaaiiiinnnnttttEEEEvvvveeeennnntttt (((( QQQQPPPPaaaaiiiinnnnttttEEEEvvvveeeennnntttt    **** ))))
      vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd rrrreeeessssiiiizzzzeeeeEEEEvvvveeeennnntttt (((( QQQQRRRReeeessssiiiizzzzeeeeEEEEvvvveeeennnntttt **** ))))
      vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd ddddrrrraaaawwwwFFFFrrrraaaammmmeeee (((( QQQQPPPPaaaaiiiinnnntttteeeerrrr **** ))))
      vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd ddddrrrraaaawwwwCCCCoooonnnntttteeeennnnttttssss (((( QQQQPPPPaaaaiiiinnnntttteeeerrrr **** ))))
      vvvviiiirrrrttttuuuuaaaallll vvvvooooiiiidddd ffffrrrraaaammmmeeeeCCCChhhhaaaannnnggggeeeedddd (((())))

     DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
      The QFrame class is the base class of    widgets    that have an
      (optional) frame.

      It draws a label and calls a virtual function,
      drawContents(), to fill in the frame.    This function is
      reimplemented    by essentially all subclasses. There are also
      two other less useful    functions, drawFrame() and
      frameChanged().



     Page 1                         (printed 9/22/98)






     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



      QMenuBar uses    this to    "raise"    the menu bar above the
      surrounding screen:

          if ( style() == MotifStyle ) {
          setFrameStyle( QFrame::Panel | QFrame::Raised    );
          setLineWidth(    2 );
          }    else {
          setFrameStyle( QFrame::NoFrame );
          }

      The QFrame class can also be used directly for creating
      simple frames    without    any contents, for example like this:

          QFrame *emptyFrame = new QFrame( parentWidget );
          emptyFrame->setFrameStyle( Panel | Sunken    );
          emptyFrame->setLineWidth(    2 );

      A frame widget has three attributes: frame style, a line
      width    and a mid-line width.

      The frame style is specified by a frame shape    and a shadow
      style. The frame shapes are NoFrame, Box, Panel, WinPanel,
      HLine    and VLine, and the shadow styles are Plain, Raised and
      Sunken.

      The line width is the    width of the frame border.

      The mid-line width specifies the width of an extra line in
      the middle of    the frame, that    uses a third color to obtain a
      special 3D effect. Notice that a mid-line is only drawn for
      Box, HLine and VLine frames that are raised or sunken.

      This table shows the most useful combinations    of styles and
      widths (and some rather useless ones):

                  [[[[IIIImmmmaaaaggggeeee OOOOmmmmiiiitttttttteeeedddd]]]]

      For obvious reasons, NoFrame isn't shown. The    gray areas
      next to the VLine and    HLine examples are there because the
      widgets are taller/wider than    the natural width of the
      lines. frameWidth() returns the natural width    of the line.

      The labels on    the top    and right are QLabel objects with
      frameStyle() Raised|Panel and    lineWidth() 1.

      Examples:  tictac/tictac.cpp life/life.cpp movies/main.cpp
      xform/xform.cpp widgets/widgets.cpp

     MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
     QQQQFFFFrrrraaaammmmeeee::::::::QQQQFFFFrrrraaaammmmeeee (((( QQQQWWWWiiiiddddggggeeeetttt ****    ppppaaaarrrreeeennnntttt====0000,,,, ccccoooonnnnsssstttt    cccchhhhaaaarrrr **** nnnnaaaammmmeeee====0000,,,, WWWWFFFFllllaaaaggggssss
      ffff====0000,,,, bbbboooooooollll aaaalllllllloooowwwwLLLLiiiinnnneeeessss====TTTTRRRRUUUUEEEE ))))
      Constructs a frame widget with frame style NoFrame and a 1



     Page 2                         (printed 9/22/98)






     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



      pixel    frame width.

      The _a_l_l_o_w_L_i_n_e_s argument can be set to    FALSE to disallow
      HLine    and VLine shapes.

      The _p_a_r_e_n_t, _n_a_m_e and _f arguments are passed to the QWidget
      constructor.

     QQQQRRRReeeecccctttt QQQQFFFFrrrraaaammmmeeee::::::::ccccoooonnnntttteeeennnnttttssssRRRReeeecccctttt    (((()))) ccccoooonnnnsssstttt
      Returns the rectangle    inside the frame.

      See also: frameRect()    and drawContents().

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::ddddrrrraaaawwwwCCCCoooonnnntttteeeennnnttttssss (((( QQQQPPPPaaaaiiiinnnntttteeeerrrr **** )))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
      Virtual function that    draws the contents of the frame.

      The QPainter is already open when you    get it,    and you    must
      leave    it open. Painter transformations are switched off on
      entry. If you    transform the painter, remember    to take    the
      frame    into account and reset transformation before
      returning.

      This function    is reimplemented by subclasses that draw
      something inside the frame. It should    draw only inside
      contentsRect(). The default function does nothing.

      See also: contentsRect() and QPainter::setClipRect().

      Reimplemented    in QLCDNumber, QMenuBar, QLabel    and
      QProgressBar.

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::ddddrrrraaaawwwwFFFFrrrraaaammmmeeee (((( QQQQPPPPaaaaiiiinnnntttteeeerrrr **** pppp )))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
      Draws    the frame using    the current frame attributes and color
      group. The rectangle inside the frame    is not affected.

      This function    is virtual, but    in general you do not need to
      reimplement it. If you do, note that the QPainter is already
      open and must    remain open.

      See also: frameRect(), contentsRect(), drawContents(),
      frameStyle() and setPalette().

      Examples:  life/life.cpp

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::ffffrrrraaaammmmeeeeCCCChhhhaaaannnnggggeeeedddd (((()))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
      Virtual function that    is called when the frame style,    line
      width    or mid-line width changes.

      This function    can be reimplemented by    subclasses that    need
      to know when the frame attributes change.

      Reimplemented    in QScrollView and QWidgetStack.



     Page 3                         (printed 9/22/98)






     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



     QQQQRRRReeeecccctttt QQQQFFFFrrrraaaammmmeeee::::::::ffffrrrraaaammmmeeeeRRRReeeecccctttt (((())))    ccccoooonnnnsssstttt
      Returns the frame rectangle.

      The default frame rectangle is equivalent to the widget
      rectangle.

      See also: setFrameRect().

     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::ffffrrrraaaammmmeeeeSSSShhhhaaaaddddoooowwww (((())))    ccccoooonnnnsssstttt
      Returns the frame shadow value from the frame    style.

      See also: frameStyle() and frameShape().

     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::ffffrrrraaaammmmeeeeSSSShhhhaaaappppeeee (((()))) ccccoooonnnnsssstttt
      Returns the frame shape value    from the frame style.

      See also: frameStyle() and frameShadow().

     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::ffffrrrraaaammmmeeeeSSSSttttyyyylllleeee (((()))) ccccoooonnnnsssstttt
      Returns the frame style.

      The default value is QFrame::NoFrame.

      See also: setFrameStyle(), frameShape() and frameShadow().

     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::ffffrrrraaaammmmeeeeWWWWiiiiddddtttthhhh (((()))) ccccoooonnnnsssstttt
      Returns the width of the frame that is drawn.

      Note that the    frame width depends on the frame style,    not
      only the line    width and the mid line width. For example, the
      style    NoFrame    always has a frame width 0, while the style
      Panel    has a frame width equivalent to    the line width.

      See also: lineWidth(), midLineWidth()    and frameStyle().

      Examples:  widgets/widgets.cpp

     bbbboooooooollll QQQQFFFFrrrraaaammmmeeee::::::::lllliiiinnnneeeeSSSShhhhaaaappppeeeessssOOOOkkkk (((()))) ccccoooonnnnsssstttt
      Returns TRUE if line shapes (HLine or    VLine) are allowed, or
      FALSE    if they    are not    allowed.

      It is    only possible to disallow line shapes in the
      constructor. The default value is TRUE.

     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::lllliiiinnnneeeeWWWWiiiiddddtttthhhh (((()))) ccccoooonnnnsssstttt
      Returns the line width. (Note    that the _t_o_t_a_l line width for
      HLine    and VLine is given by frameWidth(), not    lineWidth().)

      The default value is 1.

      See also: setLineWidth(), midLineWidth() and frameWidth().




     Page 4                         (printed 9/22/98)






     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::mmmmaaaarrrrggggiiiinnnn    (((()))) ccccoooonnnnsssstttt
      Returns the width of the margin. The margin is the distance
      between the innermost    pixel of the frame and the outermost
      pixel    of contentsRect(). It is included in frameWidth().

      The margin is    filled according to backgroundMode().

      The default value is 0.

      See also: setMargin(), lineWidth() and frameWidth().

     iiiinnnntttt QQQQFFFFrrrraaaammmmeeee::::::::mmmmiiiiddddLLLLiiiinnnneeeeWWWWiiiiddddtttthhhh (((()))) ccccoooonnnnsssstttt
      Returns the width of the mid-line.

      The default value is 0.

      See also: setMidLineWidth(), lineWidth() and frameWidth().

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::ppppaaaaiiiinnnnttttEEEEvvvveeeennnntttt (((( QQQQPPPPaaaaiiiinnnnttttEEEEvvvveeeennnntttt **** eeeevvvveeeennnntttt )))) [[[[vvvviiiirrrrttttuuuuaaaallll
      pppprrrrooootttteeeecccctttteeeedddd]]]]
      Handles paint    events for the frame.

      Paints the frame and the contents.

      Opens    the painter on the frame and calls first drawFrame(),
      then drawContents().

      Reimplemented    from QWidget.

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::rrrreeeessssiiiizzzzeeeeEEEEvvvveeeennnntttt ((((    QQQQRRRReeeessssiiiizzzzeeeeEEEEvvvveeeennnntttt **** eeee )))) [[[[vvvviiiirrrrttttuuuuaaaallll pppprrrrooootttteeeecccctttteeeedddd]]]]
      Handles resize events    for the    frame.

      Adjusts the frame rectangle for the resized widget. The
      frame    rectangle is elastic, the surrounding area is static.

      The resulting    frame rectangle    may be null or invalid.    You
      can use setMinimumSize() to avoid that possibility.

      Nothing is done if the frame rectangle is a null rectangle
      already.

      Reimplemented    from QWidget.

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::sssseeeettttFFFFrrrraaaammmmeeeeRRRReeeecccctttt (((( ccccoooonnnnsssstttt QQQQRRRReeeecccctttt &&&& rrrr )))) [[[[pppprrrrooootttteeeecccctttteeeedddd]]]]
      Sets the frame rectangle to _r.

      The frame rectangle is the rectangle the frame is drawn in.
      By default, this is the entire widget. Calling
      setFrameRect() does _n_o_t cause    a widget update.

      If _r is a null rectangle (for    example    QRect(0,0,0,0)), then
      the frame rectangle is equivalent to the widget rectangle.



     Page 5                         (printed 9/22/98)






     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



      See also: frameRect()    and contentsRect().

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::sssseeeettttFFFFrrrraaaammmmeeeeSSSSttttyyyylllleeee    (((( iiiinnnntttt ssssttttyyyylllleeee ))))
      Sets the frame style to _s_t_y_l_e.

      The _s_t_y_l_e is the bitwise OR between a    frame shape and    a
      frame    shadow style. See the illustration in the class
      documentation.

      The frame shapes are:

     style if you use this.
      NoFrame draws    nothing. Naturally, you    should not specify a shadow

     the surrounding screen, but the border itself may be raised or
     sunken.
      Box draws a rectangular box. The contents appear to be level with

      Panel    draws a    rectangular panel that can be raised or    sunken.

     Specifying    this shape sets    the line width to 2 pixels. WinPanel
     provides fancy Windows 95-like shadows.
      WinPanel draws a rectangular panel that can be raised    or sunken.

      HLine    draws a    horizontal line    (vertically centered).

      VLine    draws a    vertical line (horizontally centered).

      The shadow styles are:

     effect).
      Plain    draws using the    palette    foreground color (without any 3D

     the current color group.
      Raised draws a 3D raised line    using the light    and dark colors    of

     the current color group.
      Sunken draws a 3D sunken line    using the light    and dark colors    of

      If a mid-line    width greater than 0 is    specified, an
      additional line is drawn for Raised or Sunken    Box, HLine and
      VLine    frames.    The mid    color of the current color group is
      used for drawing middle lines.

      WWWWaaaarrrrnnnniiiinnnngggg:::: Attempts to set the frame style to HLine or VLine
      (with    any shadow style) are disregarded unless line shapes
      are allowed. Line shapes are allowed by default.

      See also: Illustration, frameStyle(),    lineShapesOk(),
      colorGroup() and QColorGroup.

      Examples:  tictac/tictac.cpp dclock/dclock.cpp



     Page 6                         (printed 9/22/98)






     QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQFFFFrrrraaaammmmeeee((((3333qqqqtttt))))



      xform/xform.cpp cursor/cursor.cpp layout/layout.cpp
      widgets/widgets.cpp

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::sssseeeettttLLLLiiiinnnneeeeWWWWiiiiddddtttthhhh (((( iiiinnnntttt wwww ))))
      Sets the line    width to _w.

      See also: frameWidth(), lineWidth() and setMidLineWidth().

      Examples:  dclock/dclock.cpp xform/xform.cpp

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::sssseeeettttMMMMaaaarrrrggggiiiinnnn (((( iiiinnnntttt wwww ))))
      Sets the width of the    margin to _w.

      See also: margin() and setLineWidth().

     vvvvooooiiiidddd QQQQFFFFrrrraaaammmmeeee::::::::sssseeeettttMMMMiiiiddddLLLLiiiinnnneeeeWWWWiiiiddddtttthhhh (((( iiiinnnntttt    wwww ))))
      Sets the width of the    mid-line to _w.

      See also:  midLineWidth() and    setLineWidth().

     SSSSEEEEEEEE AAAALLLLSSSSOOOO
      hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqffffrrrraaaammmmeeee....hhhhttttmmmmllll

     CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
      Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
      included in the distribution for a complete license
      statement.

     AAAAUUUUTTTTHHHHOOOORRRR
      Generated automatically from the source code.

























     Page 7                         (printed 9/22/98)